Favicon

You are here: Home > API Reference > Windows > Windows Commands > Get winCommand by Id or Slug

Get winCommand by Id or Slug

Get winCommand by Id or Slug

GET /v1/organizations/:organizationId/mdm/windows/enterprise/devices/:winDeviceId/commands/:winCommandId

Get winCommand by Id or Slug

Get winCommand by Id or Slug

Request

Add parameter in header authorization
Example: Authorization: Bearer <token>
organizationId string
required
Entity Id or Slug
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
winDeviceId string
required
Entity Id, IMEI or Serial Number
Match pattern: ^(([a-fA-F0-9]{24})|(\w{1,}))$
winCommandId string
required
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 500 characters
winDeviceId string optional
Entity Id
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
summary array [object] optional
status string optional
Pending Awaiting UnexpectedError Acknowledged Cancel MethodNotAllowed Unknown Unauthorized CommandFormatError CommandNotFound NotSupported DeleteWithoutArchive ItemNotDeleted AuthenticationAccepted ChunkedItemAcceptedAndBuffered OperationCanceled CommandNotExecutedUserCanceled CommandInsideAtomicElementAndAtomicFailed RequestedTargetIsOneOfMultipleAlternativesRequestedTarget RequestedTargetHasANewURI RequestedTargetMovedToADifferentURI RequestedTargetCanBeFoundAtAnotherURI RequestedSyncMLCommandNotExecutedOnTarget RequestedTargetMustBeAccessedThroughSpecifiedProxyURI PaymentIsNeeded FailedByRecipientUnderstoodTheCommand InvalidOriginatorAuthentication ExpectedMessageNotReceivedInRequiredPeriodOfTime UpdateConflictBetweenClientAndServerVersion TargetNotLongerAvailable CommandMustBeAccompaniedByByteSizeOrLength IncompleteOrIncorrectFormed RequestItemTooLong TargetURIIsTooLong UnsupportedMediaType ByteSizeTooBig RequestFailRetryAfterSomeTime PutOrAddCommandFailedBecauseTargetAlreadyExists ConflictDetectedResolvedServerCommandWinning NoMoreStorageSpaceForRemainingSynchronizationData SpecifiedSearchGrammarWasNotKnown CGIScriptingInLocURIWasIncorrectlyFormed SoftDeletedItemAlreadyHardDeleted ChunkedObjectReceivedByIncorrectSizeDeclared InvalidAdequateAccessControlPermissions PartialItemNotAccepted ParentCanNotBeDeletedSinceItContainsChildren MoveFailed CommandNotSupported GatewayOrProxyError TemporaryOverloadingOrMaintenanceError GatewayOrProxyTimeout InvalidSyncMLDTDVersion ApplicationErrorWhileProcessingTheRequest ErrorCausedAllSyncMKCommandsFail ErrorARefreshSynchronizationIsNeeded ReservedForFutureUse ErrorInRecipientDataStore SevereErrorInServer ApplicationErrorDuringSynchronization SyncMLSynchronizationVersionNotSupported SyncMlCommandCanceled AtomicRollbackFailed AtomicResponseTooLarge MalformedSyntax
action string optional
Add Copy Delete Exec Get Replace
num integer optional
≥ 0
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "winDeviceId": "string",
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z",
        "summary": [
            {
                "status": "Pending",
                "action": "Add",
                "num": 0
            }
        ]
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}